Design documentation
Contents |
[edit] Introduction
Documentation is the process, act or instance of classifying, annotating or authenticating information contained within documents for purposes of factual verification or permanent record keeping. A document is a representation of information in a written, drawn or digital form.
Design documentation is a term that is sometimes associated with the development of computer software (as in architecture design documentation) and web design (as in user experience or UX). In Design Documentation: Why You Need It, Nick Babich provides an overview of the basic ideas of design documentation for UX. This includes:
- Making documentation usable for the target audience.
- Providing up-to-date documentation.
- Working on design documentation incrementally.
- Testing documentation.
- Avoiding jargon.
- Creating easy access.
- Providing visual samples in the documentation.
Generally, this sort of design documentation should include information about users, implementation details, agreed upon decisions and project deadlines. The creation of design documentation should take place during the early stages of a project in order to clarify expectations and expedite the achievement of goals.
[edit] Building design documentation
These same basic principles can apply to design documentation for building and construction. At the very least, there should be a suitable amount of documentation written to inform staff at an appropriate level of the work that they are expected to complete.
Ideally, this collection of documents and resources should cover all design aspects of a building project, including decisions that have been made during the design process to satisfy business, legal, environmental, social, technical and so on requirements and support the execution of the design.
This can include specifications, drawings, operational information, and other relevant documents (explanatory diagrams, tables and charts, standards, surveys and so on).
The amount and depth of the documentation will depend on the requirements of the design brief, and other documentation such as employers information requirements.
There are a number of articles on Designing Buildings describing particular types of documentation and documents:
- Contract documents.
- Tender documentation.
- Types of drawings.
- Briefing documents.
- Specifications.
- Legislation.
- Regulations.
- Planning permission.
- Certificates.
- Permits.
- Approvals.
- BIM.
- Construction contract certificates, notices and instructions.
For more information see: Design process.
[edit] Related articles on Designing Buildings
- Commissioning documentation.
- Document.
- Handover to client.
- Project brief for design and construction.
- Quality management systems (QMS) - beyond the documentation.
- Record keeping.
- User experience UX.
[edit] External resources
- Nick Babich, Design Documentation: Why You Need It.
Featured articles and news
RTPI leader to become new CIOB Chief Executive Officer
Dr Victoria Hills MRTPI, FICE to take over after Caroline Gumble’s departure.
Social and affordable housing, a long term plan for delivery
The “Delivering a Decade of Renewal for Social and Affordable Housing” strategy sets out future path.
A change to adoptive architecture
Effects of global weather warming on architectural detailing, material choice and human interaction.
The proposed publicly owned and backed subsidiary of Homes England, to facilitate new homes.
How big is the problem and what can we do to mitigate the effects?
Overheating guidance and tools for building designers
A number of cool guides to help with the heat.
The UK's Modern Industrial Strategy: A 10 year plan
Previous consultation criticism, current key elements and general support with some persisting reservations.
Building Safety Regulator reforms
New roles, new staff and a new fast track service pave the way for a single construction regulator.
Architectural Technologist CPDs and Communications
CIAT CPD… and how you can do it!
Cooling centres and cool spaces
Managing extreme heat in cities by directing the public to places for heat stress relief and water sources.
Winter gardens: A brief history and warm variations
Extending the season with glass in different forms and terms.
Restoring Great Yarmouth's Winter Gardens
Transforming one of the least sustainable constructions imaginable.
Construction Skills Mission Board launch sector drive
Newly formed government and industry collaboration set strategy for recruiting an additional 100,000 construction workers a year.
New Architects Code comes into effect in September 2025
ARB Architects Code of Conduct and Practice available with ongoing consultation regarding guidance.
Welsh Skills Body (Medr) launches ambitious plan
The new skills body brings together funding and regulation of tertiary education and research for the devolved nation.
Paul Gandy FCIOB announced as next CIOB President
Former Tilbury Douglas CEO takes helm.
UK Infrastructure: A 10 Year Strategy. In brief with reactions
With the National Infrastructure and Service Transformation Authority (NISTA).